Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature #4 gist api module PR 재등록 #50

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Conversation

kimhji
Copy link
Collaborator

@kimhji kimhji commented Nov 13, 2024

#️⃣연관된 이슈

#4

📝작업 내용

GET /gist
사용자의 모든 gist 가져오기

[
	{
		id: string
		description : string
		files:[
			{
				file_name : string
				raw_url : string
				type : string
				language : string
				size : number
				content : string
			}
		]
		public : boolean
		owner : {
			login : string
			id : number
			avatar_url : string
		}
	}
]

GET /gist/Last
사용자의 가장 최근 gist 가져오기

{
	id: string
	description : string
	files:[
		{
			file_name : string
			raw_url : string
			type : string
			language : string
			size : number
			content : string
		}
	]
	public : boolean
	owner : {
		login : string
		id : number
		avatar_url : string
	}
}

GET /gist/user
사용자 정보 가져오기

{
    "id": number,
    "avatar_url": string,
    "login": string
}

GET /gist/:id
해당 id의 gist 정보 가져오기

{
    "id": string,
    "description": string,
    "files": [
        {
            "file_name": string,
            "raw_url": string
            "type": string,
            "language": string,
            "size": number,
            "content": string
        }
	],
	"public" : boolean,
	"owner":{
		"login" : string,
		"id" : number,
		"avatar_url" : string
	}
}

GET /gist/:gist_id/commits, /gist/:gist_id/commits/:pageIdx
gist의 commit 목록 가져오기

[
    {
        "committed_at": Date,
        "url": string
    }
]

GET /gist/:gist_id/commit/:id
특정 commit의 file들 가져오기

{
    "id": string,
    "description": string,
    "files": [
        {
            "file_name": string,
            "raw_url": string
            "type": string,
            "language": string,
            "size": number,
            "content": string
        }
	],
	"public" : boolean,
	"owner":{
		"login" : string,
		"id" : number,
		"avatar_url" : string
	}
}

GET /gist/:gist_id/comments
gist의 comment들 가져오기

[
    {
		"id": number,
		"created_at": Date,
		"body": string,
		"owner": {
			"id": number,
			"login": string,
			"avatar_url": string
		}
	}
]

Post /gist/:gist_id/comment
Body{
"comment": string
}
comment 생성

{
    "id": number,
    "created_at": Date,
    "body": string,
    "owner": {
        "id": number,
        "login": string,
        "avatar_url": string
    }
}

PATCH /gist/:gist_id/comment/:comment_id
Body{
"comment": string
}
특정 comment의 내용 수정

boolean

DELETE /gist/:gist_id/comment/:comment_id
특정 comment 삭제

boolean 

스크린샷 (선택)

예시로 commit 목록 가져오기 사진 첨부합니다.
image

💬리뷰 요구사항(선택)

gist 목록 가져오기에서 file 내용까지 다 같이 가져오게 하니까 좀 느립니다. content는 목록 가져오기에서 뺄까요?
=> 현재는 빼놓았습니다.

@kimhji kimhji self-assigned this Nov 13, 2024
@naarang naarang changed the title Feature #4 gist api module PR 재등 Feature #4 gist api module PR 재등록 Nov 13, 2024
Copy link
Collaborator

@naarang naarang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm👍

@kimhji kimhji merged commit 687688a into main Nov 13, 2024
1 check passed
@kimhji kimhji deleted the feature-#4-gist_api_module2 branch November 13, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants